package com.google.code.solrdimension.queryresponse;

import org.apache.solr.client.solrj.response.QueryResponse;

import com.google.code.solrdimension.config.DimensionConfigWrapper;
import com.google.code.solrdimension.core.DimensionQuery;
import com.google.code.solrdimension.core.DimensionResponse;
import com.google.code.solrdimension.parsers.exception.SolrDimensionException;

/**
 * Translate from a SOLR {@link QueryResponse} object to a {@link DimensionQuery} object
 * @author mhc
 *
 */
public interface QueryResponseInterpreter {
    
    /**
     * The method responsible for the translation. Note that this method only interpret the 
     * 
     * "Facet" parts of the responses, i.e
     *  {@link QueryResponse#getFacetFields()}, {@link QueryResponse#getFacetQuery()}
     * 
     * 
     * 
     * @param solrQueryResponse
     *          The {@link QueryResponse} from SOLR
     * @param config
     *          {@link DimensionConfigWrapper} 
     * @return
     *        {@link DimensionResponse}
     */
    public DimensionResponse interpretQueryResponse(QueryResponse solrQueryResponse, DimensionConfigWrapper config) throws SolrDimensionException;
    
}
